Skip to main content

Configuring Click to Pay

Click to Pay requires some initial configuration steps before it can be used to generate payment links.

Before Starting​

You'll need:

  • The full URL address of your Click to Pay page.
  • Your Click to Pay Profile ID. This was provided to you by EPASS. If you don't have this ID, contact EPASS Support.

Activate Click to Pay Security Options​

  1. Go to Tools > System Maintenance. On the Tables tab, select User Security, and then click Open.

  2. Select a User or Group from the list, and then click Security.

  3. In the Keyword search box, enter CLICK TO PAY and select the following options:

    Click to Pay - View Payment LinkEnables the Click to Pay link in the Invoice Header. Without this option, the EPASS User can not generate a payment link.
    Click to Pay - Allow Requested AmountAllows the EPASS User to generate a Click to Pay link that forces the customer to pay a specific amount. If this is not enabled, the Click to Pay link will request the amount owing on the invoice, but the customer can choose to pay a lesser amount.

  4. Click OK.

Add Click to Pay Variables​

  1. Go to Tools > System Maintenance.

    img

  2. Click the Variables tab.

  3. Click EPASS Pay, and then click Open.

    ClicktoPay_20

  4. Click the Click to Pay tab and do the following:

    CTP_Variables_Updated_1

    AEnter the URL address where your Click to Pay page is hosted.
    BEnter your Click to Pay Profile ID.
    CIf necessary, change the default number of days the authentication token is valid for. If the authentication token expires, the user can still follow the link to pay their invoice, however, they will need to manually enter their name and invoice number at the payment portal.
    info

    If you set the Token Validity Days to 0, the Click to Pay link is generated without an authentication token.

About URL Shortening​

Click to Pay URL links are “shortened” using the TinyURL service. You can choose to disable this service and instead have Click to Pay generate an “expanded” URL link.

Tiny URL Link

Expanded URL Link

Some network services and business block shortened URLs. If your Click to Pay recipients are having trouble receiving shortened URL links, you may need to disable URL shortening.

Select URL Shortening Variables​

  1. Select the following:

    CTP_Variables_Updated_2

    AClick to enable or disable URL shortening.
    BThis is how long EPASS will wait for a response from the TinyURL service. If a response isn’t returned in time, an error is generated. We recommend leaving this set to 5 seconds, but if you have a slower internet connection or are experiencing multiple timeout errors, you can try increasing the time
    CSelect this checkbox if you want to use shortened URLs in your staging environment.

Activate Click to Pay for Invoice Types​

By default, Click to Pay is disabled for all Invoice Types. You'll need to decide which Invoice Types can generate Click to Pay payment links and then activate the Click to Pay feature in each one.

  1. Go to Tools > System Maintenance.

  2. On the Tables tab, click Invoice Type, and then click Open.

  3. Click an Invoice Type, and then click Edit.

    img

  4. On the Settings 1 tab near the bottom, click Show Click to Pay Payment Link.img

  5. Click OK.

  6. Repeat steps 3–5 for each Invoice Type that will use Click to Pay payment links.

Add a Click to Pay Payment Type​

A unique Payment Type for Click to Pay payments must be added to EPASS. EPASS links all payments received through Click to Pay to this Payment Type code.

Follow these instructions to add a Click to Pay Payment Type.

  1. Go to Tools > System Maintenace. On the Tables tab, click Payment Types, and then click Open.

    img

  2. In the Payment Type window, click Add.

  3. Fill in the following fields:

    img

    AEnter a Code and Description. We recommend using code EPCTP.
    BSelect the G/L Account that this payment type should link to.
    CClear all of these checkboxes so that EPCTP isn’t an available payment option in the Invoice Header, Invoice Detail, or Mobile Tech.
    DSelect EPASS Pay – Credit from the Type dropdown.
    info

    Prevent Duplicate Card Payments is used for fraud prevention, and we recommend that this setting is always selected.

  4. Click OK.

Configure Click to Pay Messaging​

EPASS can send a message or notification to a list of EPASS users or groups when a Click to Pay payment is successfully made or declined by a customer. These messages, and the list of users that receive them, are configured in the EPASS Messaging System.

Click to Pay Event Messaging

Click to Pay Event Notification Reminder

To Configure Click to Pay Event Messaging​

  1. Go to Tools > System Maintenance, and then click the Variables tab.

  2. Click Message, and then click Open.

    image-20241025104142605

  3. Click the Message Events tab.

    img

  4. In the Message Events list, scroll down until you see Successful CTP Payment Event and Declined CTP Payment Event. Select their checkboxes to activate these events.

    img

  5. Select the Successful CTP Event and then click Details.

    img

  6. Do the following:

    img

    AFor each user or group that should receive this message, click their name in the Users in System list, and then click the left arrow img to move them into the To list.
    BSelect whether the recipients receive a message in their EPASS Messaging Inbox (select Message) or a notification reminder pop-up when they log in (select Reminder). If Reminder is selected, enter the number of hours or days that will pass before the user receives the pop-up notification.
    CIf necessary, edit the default Subject line and Message body.

  7. Click OK and repeat step 6 for the Declined CTP Message Event.

See Also​

Updated

April 28, 2025